Boost 12 Click Driver

API for configuring and manipulating Boost 12 Click driver. More...

Topics
	Boost 12 PWM Settings
	Settings for configuration of Boost 12 Click driver.
	Boost 12 MikroBUS Map
	MikroBUS pin mapping of Boost 12 Click driver.

Functions
void	boost12_cfg_setup (boost12_cfg_t *cfg)
	Boost 12 configuration object setup function.
err_t	boost12_init (boost12_t *ctx, boost12_cfg_t *cfg)
	Boost 12 initialization function.
err_t	boost12_default_cfg (boost12_t *ctx)
	Boost 12 default configuration function.
err_t	boost12_set_duty_cycle (boost12_t *ctx, float duty_cycle)
	Boost 12 sets PWM duty cycle.
err_t	boost12_pwm_stop (boost12_t *ctx)
	Boost 12 stop PWM module.
err_t	boost12_pwm_start (boost12_t *ctx)
	Boost 12 start PWM module.

Detailed Description

API for configuring and manipulating Boost 12 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

boost12_cfg_setup()

void boost12_cfg_setup

(

boost12_cfg_t *

cfg

)

Boost 12 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See boost12_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

boost12_default_cfg()

err_t boost12_default_cfg

(

boost12_t *

ctx

)

Boost 12 default configuration function.

This function executes a default configuration of Boost 12 Click board.

Parameters

[in]

ctx

: Click context object. See boost12_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

This function can consist any necessary configuration or setting to put device into operating mode.

boost12_init()

err_t boost12_init	(	boost12_t *	ctx,
		boost12_cfg_t *	cfg )

Boost 12 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See boost12_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See boost12_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

boost12_pwm_start()

err_t boost12_pwm_start

(

boost12_t *

ctx

)

Boost 12 start PWM module.

This function starts the PWM module output.

Parameters

[in]

ctx

: Click context object. See boost12_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

boost12_pwm_stop()

err_t boost12_pwm_stop

(

boost12_t *

ctx

)

Boost 12 stop PWM module.

This function stops the PWM module output.

Parameters

[in]

ctx

: Click context object. See boost12_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

boost12_set_duty_cycle()

err_t boost12_set_duty_cycle	(	boost12_t *	ctx,
		float	duty_cycle )

Boost 12 sets PWM duty cycle.

This function sets the PWM duty cycle in percentages ( Range[ 0..1 ] ).

Parameters

[in]	ctx	: Click context object. See boost12_t object definition for detailed explanation.
[in]	duty_cycle	: PWM duty cycle.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.